HR - Timesheets - REST API icon

HR - Timesheets - REST API

1.0.x
(0 reviews)

Spec - Timesheets OUT - REST API

The HR - Timesheets API supports the following endpoints:

GET /rest/v2/hr/timesheets

This endpoint allowing to GET the detailed information about a timesheets

This endpoint supports GET operation and must take the following query parameters:
  • companyCode (required) : Codex company code
  • workDateSince combined with workDateSince : Effective booked date range of the timesheets. ++Delta can't be higher than 30 days++
    • or
  • updSince combined with updBefore: Date range of when the timesheets has been saved in the ERP. ++Delta can't be higher than 30 days++
Additionnal filters can be added:
  • buCode: The BusinessUnit code for which you want timesheets
  • employeeNumber: The Codex employee number for which you want to retreive timesheets
This endpoints also support an "expand" parameter:
  • expandToTexts: Will fill in the response bloc "timesheetTexts"with the informations related of the comments in the timesheet, and therefore add this structure to the response:
"timesheetTexts":
[
  {
    "sequence": "123456",
    "comments": "My comments",
    "commentsLanguage": "FR"
  }
]
This endpoint requires the next HTTP headers
Content-type: application/json
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}
The payload returned propose a pagination if ever there's more than 999 results:
 "links": {
    "selfRef": "https://***/rest/v1/timesheets?limit=999&page=3",
    "firstRef": "https://***/rest/v1/timesheets?limit=999&page=1",
    "previousRef": "https://***/rest/v1/timesheets?limit=999&page=2",
    "nextRef": "https://***/rest/v1/timesheets?limit=999&page=4"
  },
  "currentPage": 3,
  "totalPages": 5,
  "error": {}

######

Example of a payload returned by the GET operation :
{
  "header": {
    "apiName": "s-api-myAPI",
    "apiVersion": "1.0",
    "correlationId": "ab7cdcd7-b71a-4554-87e8-61bdea42ab28"
  },
  "data": [
    {
      "sequence": "000123456",
      "erpEmployeeId": "987654",
      "companyCode": "D023",
      "personId": "",
      "workDate": "2025-05-02",
      "employeeFullName": "ABCD",
      "costCenter": "ABC12345C",
      "projectId": "",
      "displayedUnitOfMeasure": "H",
      "numberHours": "0.50",
      "timesheetTypeCode": "IS09",
      "wageType": "",
      "unitOfMeasure": "H",
      "wageQuantity": "0.500",
      "currency": "",
      "wageAmount": "0.00",
      "timesheetName": "Std/Remote/Bill",
      "activityTypeInfoType": "S09",
      "activityType": "S09",
      "managerId": "987654321",
      "managerFullName": "Toto Tati",
      "processingStatus": "30",
      "startTime": "09:00:00",
      "endTime": "10:00:00",
      "description": "",
      "interventionLabel": "",
      "craftCode": "",
      "receiverOrder": "AD0123456789",
      "createdDate": "2025-05-02T00:00:00",
      "createdBy": "ABCD",
      "lastUpdateDate": "2025-05-02T00:00:00",
      "lastChangeBy": "EFGH",
      "approvedDate": "2025-05-02",
      "approvedBy": "EFGH",
      "timesheetTexts": [
        {
          "sequence": "123456",
          "comments": "My comments",
          "commentsLanguage": "FR"
        }
      ]
    }
  ],
  "links": {
    "selfRef": "https://hr-timesheets-exp.***/rest/v1/timesheets?limit=100&page=3",
    "firstRef": "https://hr-timesheets-exp.***/rest/v1/timesheets?limit=100&page=1",
    "previousRef": "https://hr-timesheets-exp.***/rest/v1/timesheets?limit=100&page=2",
    "nextRef": "https://hr-timesheets-exp.***/rest/v1/timesheets?limit=100&page=4"
  },
  "currentPage": 3,
  "totalPages": 5,
  "error": {}
}

Reviews